/*
 * Copyright (c) 2013   Tobias Welther
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package de.tudarmstadt.kom.androidsensorapi.sensor.data.concrete;

import android.hardware.Sensor;
import android.hardware.SensorEvent;

import java.util.Date;

import de.tudarmstadt.kom.androidsensorapi.sensor.data.AbstractSensorData;

/**
 * Created by Tobias Welther
 */
public class ProximitySensorData extends AbstractSensorData{

    /**
     * This is the proximity that the proximity SensorInterface on the front is measuring.
     * This value is in CM (Centimeters).
     *
     * CAUTION: Some proximity sensors provide only binary values representing near and far.
     */
    private final float proximity;

    /**
     * Creates a SensorInterface Data Set with an creation date.
     *
     * @param dateOfCreation the date the event was created
     * @param proximity the proximity provided by the SensorInterface
     */
    public ProximitySensorData(Date dateOfCreation, float proximity) {
        super(dateOfCreation);

        this.proximity = proximity;
    }


    /**
     * Generates Proximity Data from a given SensorEvent.
     * It is assumed that the Event is of type: SensorInterface.TYPE_PROXIMITY.
     *
     * This can throw an unsupported Operation Exception when the wrong or insufficient Data is passed.
     *
     * @param event to copy from
     *
     * @throws UnsupportedOperationException when wrong event is passed.
     */
    public ProximitySensorData(SensorEvent event){
        super(event);

        if(event.sensor.getType() != Sensor.TYPE_PROXIMITY ||
                event.values.length < 1){

            throw new UnsupportedOperationException("The Proximity Data can not be read from: "
                    + event.sensor.getName());
        }

        float[] values = event.values;
        this.proximity = values[0];
    }


    /**
    * This is the proximity that the proximity SensorInterface on the front is measuring.
    * The value is in CM (Centimeters).
    *
    * CAUTION: Some proximity sensors provide only binary values representing near and far.
    */
    public float getProximity() {
        return proximity;
    }
}
